home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1504.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  1.8 KB  |  85 lines
  1. 114
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. RenameFile 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baRenameFile renames a file or folder.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baRenameFile( FileName , NewName )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String 
  36. --- RECORDSEPARATOR ---
  37. FileName is the file to rename. 
  38. --- RECORDSEPARATOR ---
  39. NewName is the new name for the file.
  40. --- RECORDSEPARATOR ---
  41.  
  42. --- RECORDSEPARATOR ---
  43. Returns:
  44. --- RECORDSEPARATOR ---
  45.  
  46. --- RECORDSEPARATOR ---
  47. Integer. 
  48. --- RECORDSEPARATOR ---
  49. Returns 1 if the file was successfully renamed, else 0.
  50. --- RECORDSEPARATOR ---
  51.  
  52. --- RECORDSEPARATOR ---
  53. Examples:
  54. --- RECORDSEPARATOR ---
  55.  
  56. --- RECORDSEPARATOR ---
  57. Director: 
  58. --- RECORDSEPARATOR ---
  59. set OK = baRenameFile( "c:\data\student.dat" , "c:\data\student.bak" ) 
  60. --- RECORDSEPARATOR ---
  61. Authorware: 
  62. --- RECORDSEPARATOR ---
  63. OK := baRenameFile( "c:\\data\\student.dat" , "c:\\data\\student.bak" )
  64. --- RECORDSEPARATOR ---
  65.  
  66. --- RECORDSEPARATOR ---
  67. Notes:
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. This function will fail if a file called NewName already exists. The full path name to 
  72. --- RECORDSEPARATOR ---
  73. both the FileName and the NewName should be given. You can use this function to 
  74. --- RECORDSEPARATOR ---
  75. move a file to a different folder, providing it is on the same drive. You can also 
  76. --- RECORDSEPARATOR ---
  77. rename folders.
  78. --- RECORDSEPARATOR ---
  79.  
  80. --- RECORDSEPARATOR ---
  81. See also:
  82. --- RECORDSEPARATOR ---
  83.  
  84. --- RECORDSEPARATOR ---
  85. baFileExists